postRequestForQuotation
postRequestForQuotation
Path Parameters
- api-endpoint uuid required
The API endpoint to send a request for quotation to a manufacturer.
- application/json
Request Body
- filter string required
The filter to use.
- 200
- 401
- 402
- 403
- 404
The request was successful.
- application/json
- Schema
- Example (from schema)
Schema
rfqIdentification object
all properties necessary for identification of the request for quotation
rfqSource stringRFQ-Identification: digital address of the sender (e.g.token, IP address, link, user account)
rfqId stringRFQ-Identification: internal identifier in user account
rfqName stringRFQ-Identification: name for the request for user account management (usually name of the product to be manufactured)
rfqDateTime stringPossible values: Value must match regular expression
-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\.[0-9]+)?|(24:00:00(\.0+)?))(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?
RFQ-Identification: date and time of the request in user account
rfqVersion stringRFQ-Identification: version of this request in case there were any changes
rfqConfiguration object
all information to configure a request for quotation
cadFile object
RFQ-Configuration: CAD file as geometry definition, e.g. step file
fileType stringRFQ-Configuration: file format
filePath stringpath or address to the file
fileName stringname of the file
fileObject object
the file object itself, in case this could be sent via the API
parts object
RFQ-Configuration: list of parts contained in the CAD file
partId stringRFQ-PartConfiguration: identifier of the part from CAD File
partName stringRFQ-PartConfiguration: name of the part in CAD file. In case the CAD file has only one part, this could also be the file name.
manufacturingDomain stringRFQ-PartConfiguration: domain of required process (e.g. subtractive manufacturing, additive manufacturing, assembly)
generalTolerance stringRFQ-PartConfiguration: selection of defined tolerance classes
additionalRequirements stringRFQ-PartConfiguration: specific requirements e.g. to guarantee quality, like premium quality check or standard quality check or test part required (makes only sense for batch)
material object
RFQ-PartConfiguration: material definition with further information
materialProperties object
material definition with additional detail properties with name, value and value type, like name= density, value=2.7, type=g/m3 or name= chemical term, value=AlMgMn, type=periodic table
value stringvalue to detail the part material item
valueType stringvalue type to specify the value of the property
propertyName stringname of the property
materialFamily stringdefinition of material family for preselection
partQuantity object
RFQ-PartConfiguration: Quantity of which the part item is assembled into the parent item (within the CAD File). In general it is '1' for serialized parts.
quantityNumber numberThe number of objects related to the measurement unit
measurementUnit stringPossible values: Value must match regular expression
[a-zA-Z]*:[a-zA-Z]+
Unit of Measurement for the quantity of serialized objects
billOfProcess object
RFQ-PartConfiguration: list of process steps for part to be manufactured
process object[]
List that contains all manufacturing steps of a product, whereat each manufacturing step refers to exactly one capability. This list contains all process steps that are required to manufacture the product, specified with the bill of process
processStepIdentifier string[]Unique identifier for a concrete process step
inputParameters object[]
Optional list of parameters that are required to execute the corresponding process step
name stringName of the parameter
value stringValue of the parameter
semanticReference string[]Reference to a semantic namespace in which the type of the parameter is defined
parameterKey stringPossible values: [
HasValue
,HasNoValue
,HasValueRange
,HasTolerances
]Enumeration that is used to distinguish whether the parameter has no value, has a value, has a value range or has a value with tolerances
valueRangeList object[]
List with value ranges for a parameter
lowerValue stringLower border of a value range item
upperValue stringUpper border for a value range item
name stringName of the parameter
tolerances object[]
Tolerances for a parameter
lowerLimit stringThe lower direct limit of the tolerance
upperLimit stringUpper direct limit of the tolerance
name stringName of the parameter
outputParameters object[]
Optional list of parameters that are returned from the process step and can be used as inputParameters for subsequent steps
name stringName of the parameter
value stringValue of the parameter
semanticReference string[]Reference to a semantic namespace in which the type of the parameter is defined
parameterKey stringPossible values: [
HasValue
,HasNoValue
,HasValueRange
,HasTolerances
]Enumeration that is used to distinguish whether the parameter has no value, has a value, has a value range or has a value with tolerances
valueRangeList object[]
List with value ranges for a parameter
lowerValue stringLower border of a value range item
upperValue stringUpper border for a value range item
name stringName of the parameter
tolerances object[]
Tolerances for a parameter
lowerLimit stringThe lower direct limit of the tolerance
upperLimit stringUpper direct limit of the tolerance
name stringName of the parameter
precedenceRelation object[]
List of alternative process steps from which the manufacturer has to select exactly one step to be executed. In case of no alternative process step, the list features only one element. In case of the last element, the property is not used, since the process step has no successor
precedenceElements object[]
List process steps that must be executed in parallel
successor string[]List of subsequent process step which can be executed in any order
childProcessSteps string[]List of child processes that need to be executed to complete the parent process step. It enables the expression of hierarchies between capabilities, e.g. a transport capability needs to execute at least a pick, a move and a place capability
processStepType stringPossible values: [
IsFirstElement
,IsLastElement
,IsProcessElement
,IsSubprocessElement
]Distinguishes process steps based on whether there are the first or last process step to be executed, or if they are a subprocess step, which subdivides a higher-level process step into smaller process steps
capabilityId stringLocally unique identifier for a capability.
productVersion stringVersion of the product whose manufacturing steps are specified with the bill of process. It can for example specify a concrete variant of a product
productName stringName of the product whose production steps are specified within the bill of process
billOfProcessIdentification stringUnique identifier for a bill of process that can be used to reference instances of the bill of process
version stringPossible values: Value must match regular expression
^(0|[1-9][0-9]*).(0|[1-9][0-9]*).(0|[1-9][0-9]*)(-(0|[1-9A-Za-z-][0-9A-Za-z-]*)(.[0-9A-Za-z-]+)*)?([0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?$
The unique identifier of the aspect model defining the structure and the semantics of the message's header. The version number should reflect the versioning schema of aspect models in Catena-X.
firstDeliveryDate dateRFQ-Configuration: Date of desired, first, but not must delivery
lastDeliveryDate dateRFQ-Configuration: date of required and last acceptable delivery
additionalComments stringRFQ-Configuration: placeholder for any kind of additional comments
additionalFiles object
RFQ-Configuration: in case there are additional documents or files to share (like e.g. technical drawings)
fileType stringRFQ-Configuration: file format
filePath stringpath or address to the file
fileName stringname of the file
fileObject object
the file object itself, in case this could be sent via the API
orderQuantity object
RFQ-Configuration: quantity at all, valid for complete order (usually number of products to be ordered)
quantityNumber numberThe number of objects related to the measurement unit
measurementUnit stringPossible values: Value must match regular expression
[a-zA-Z]*:[a-zA-Z]+
Unit of Measurement for the quantity of serialized objects
rfqSender object
all data about sender of request for quotation, important for offer and delivery
senderName stringRFQ-Sender: name of the sender
senderAdress stringRFQ-Sender: BPDM/ or fill in by the customer, address of sender
senderCompanyName stringRFQ-Sender: BPDM/ or fill in by the customer, company name of sender
senderEMail stringRFQ-Sender: BPDM/ or fill in by the customer, e-mail address of sender
senderPhoneNumber stringRFQ-Sender: BPDM/ or fill in by the customer, phone number of sender
senderAccountAddress stringRFQ-Sender: BPDM/ or fill in by the customer, address of sender for account
senderDeliveryAddress stringRFQ-Sender: BPDM/ or fill in by the customer, address of sender for delivery
deliveryRequirements stringRFQ-Sender: filled by customer, any kind of delivery requirements
cxHeader object
header information by Catena-X
messageId stringPossible values: Value must match regular expression
(^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)|(^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)
Unique ID identifying the message. The purpose of the ID is to uniquely identify a single message, therefore it MUST not be reused.
context stringInformation about the context the message should be considered in. The value MUST consist of two parts: an identifier of the context (e.g. business domain, etc.) followed by a version number. Both the identifier and the version number MUST correspond to the content of the message. If the content of a message is described by an aspect model available in the Catena-X Semantic Hub, then the unique identifier of this semantic model (e.g. urn:samm:io.catenax.
:1.x.x) MUST be used as a value of the context field. This is considered the default case. In all other cases the value of the context field MUST follow the pattern - - sentDateTime stringPossible values: Value must match regular expression
-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\.[0-9]+)?|(24:00:00(\.0+)?))(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?
Time zone aware timestamp holding the date and the time the message was sent by the sending party. The value MUST be formatted according to the ISO 8601 standard
senderBpn stringPossible values: Value must match regular expression
^BPNL[a-zA-Z0-9]{12}$
The Business Partner Number of the sending party. The value MUST be a valid BPN. BPNA and BPNS are not allowed. Applicable constraints are defined in the corresponding standard
receiverBpn stringPossible values: Value must match regular expression
^BPNL[a-zA-Z0-9]{12}$
The Business Partner Number of the receiving party. The value MUST be a valid BPN. BPNA and BPNS are not allowed. Applicable constraints are defined in the corresponding standard.
expectedResponseBy stringPossible values: Value must match regular expression
-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\.[0-9]+)?|(24:00:00(\.0+)?))(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?
Time zone aware timestamp holding the date and time by which the sending party expects a certain type of response from the receiving party. The meaning and interpretation of the fields's value are context-bound and MUST therefore be defined by any business domain or platform capability making use of it. The value MUST be formatted according to the ISO 8601 standard
relatedMessageId stringPossible values: Value must match regular expression
(^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)|(^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)
Unique ID identifying a message somehow related to the current one
version stringPossible values: Value must match regular expression
^(0|[1-9][0-9]*).(0|[1-9][0-9]*).(0|[1-9][0-9]*)(-(0|[1-9A-Za-z-][0-9A-Za-z-]*)(.[0-9A-Za-z-]+)*)?([0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?$
The unique identifier of the aspect model defining the structure and the semantics of the message's header. The version number should reflect the versioning schema of aspect models in Catena-X.
{
"rfqIdentification": {
"rfqSource": "string",
"rfqId": "string",
"rfqName": "string",
"rfqDateTime": "string",
"rfqVersion": "string"
},
"rfqConfiguration": {
"cadFile": {
"fileType": "string",
"filePath": "string",
"fileName": "string",
"fileObject": {}
},
"parts": {
"partId": "string",
"partName": "string",
"manufacturingDomain": "string",
"generalTolerance": "string",
"additionalRequirements": "string",
"material": {
"materialProperties": {
"value": "string",
"valueType": "string",
"propertyName": "string"
},
"materialFamily": "string"
},
"partQuantity": {
"quantityNumber": 0,
"measurementUnit": "string"
},
"billOfProcess": {
"process": [
{
"processStepIdentifier": [
"string"
],
"inputParameters": [
{
"name": "string",
"value": "string",
"semanticReference": [
"string"
],
"parameterKey": "HasValue",
"valueRangeList": [
{
"lowerValue": "string",
"upperValue": "string",
"name": "string"
}
],
"tolerances": [
{
"lowerLimit": "string",
"upperLimit": "string",
"name": "string"
}
]
}
],
"outputParameters": [
{
"name": "string",
"value": "string",
"semanticReference": [
"string"
],
"parameterKey": "HasValue",
"valueRangeList": [
{
"lowerValue": "string",
"upperValue": "string",
"name": "string"
}
],
"tolerances": [
{
"lowerLimit": "string",
"upperLimit": "string",
"name": "string"
}
]
}
],
"precedenceRelation": [
{
"precedenceElements": [
{
"successor": [
"string"
]
}
]
}
],
"childProcessSteps": [
"string"
],
"processStepType": "IsFirstElement",
"capabilityId": "string"
}
],
"productVersion": "string",
"productName": "string",
"billOfProcessIdentification": "string",
"version": "string"
}
},
"firstDeliveryDate": "2024-04-08",
"lastDeliveryDate": "2024-04-08",
"additionalComments": "string",
"additionalFiles": {
"fileType": "string",
"filePath": "string",
"fileName": "string",
"fileObject": {}
},
"orderQuantity": {
"quantityNumber": 0,
"measurementUnit": "string"
}
},
"rfqSender": {
"senderName": "string",
"senderAdress": "string",
"senderCompanyName": "string",
"senderEMail": "string",
"senderPhoneNumber": "string",
"senderAccountAddress": "string",
"senderDeliveryAddress": "string",
"deliveryRequirements": "string"
},
"cxHeader": {
"messageId": "string",
"context": "string",
"sentDateTime": "string",
"senderBpn": "string",
"receiverBpn": "string",
"expectedResponseBy": "string",
"relatedMessageId": "string",
"version": "string"
}
}
Payload or user input is invalid. See error details in the payload for more.
- application/json
- Schema
- Example (from schema)
Schema
error object
message stringPossible values:
non-empty
path stringPossible values:
non-empty
details object
Possible values:
non-empty
property name*
objectcode string
{
"error": {
"message": "string",
"path": "string",
"details": {},
"code": "string"
}
}
The requesting user or client is not authenticated.
The requesting user or client is not authorized to access resources for the given tenant.
The requested Twin has not been found.